Cisco-IOS-XR-ipv4-pim-cfg API API Reference
API generated from Cisco-IOS-XR-ipv4-pim-cfg@2017-10-15.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
PIM - Update
Update operation of resource: pim
pimbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}, {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PIM - Create
Create operation of resource: pim
pimbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}, {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PIM - Delete
Delete operation of resource: pim
Successful operation
Internal Error
Response Content-Types: application/json
PIM - Retrieve
Retrieve operation of resource: pim
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}, {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
],
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
},
"rp-static-deny": "string", Configure static RP deny range "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
},
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
]
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ : {Configure Candidate-RPs : [No description {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, : {Configure Non-stop forwarding (NSF) options "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], : {Configure AutoRP Mapping Agent : {Specifications for Mapping Agent configured\non this box "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, : {Mapping Agent cache size limit "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", Enable Multicast Only FRR
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes : {Configure RPF-redirect feature "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", Enable Multicast Only FRR
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", Enable Multicast Only FRR
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Mask length
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ : {Configure Candidate-RPs : [No description {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, : {Configure Non-stop forwarding (NSF) options "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], : {Configure AutoRP Mapping Agent : {Specifications for Mapping Agent configured\non this box "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, : {Mapping Agent cache size limit "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", Enable Multicast Only FRR
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes : {Configure RPF-redirect feature "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", Enable Multicast Only FRR
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", Enable Multicast Only FRR
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Mask length
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Configure Candidate-RPs : [No description {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, : {Configure Non-stop forwarding (NSF) options "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], : {Configure AutoRP Mapping Agent : {Specifications for Mapping Agent configured\non this box "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, : {Mapping Agent cache size limit "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", Enable Multicast Only FRR
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes : {Configure RPF-redirect feature "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", Enable Multicast Only FRR
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", Enable Multicast Only FRR
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Mask length
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
SPARSE-MODE-RP-ADDRESSES - Update
Update operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Create
Create operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Delete
Delete operation of resource: sparse-mode-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Retrieve
Retrieve operation of resource: sparse-mode-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
SPARSE-MODE-RP-ADDRESS - Update
Update operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Create
Create operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Delete
Delete operation of resource: sparse-mode-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Retrieve
Retrieve operation of resource: sparse-mode-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
RPF - Update
Update operation of resource: rpf
rpfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Create
Create operation of resource: rpf
rpfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Delete
Delete operation of resource: rpf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Retrieve
Retrieve operation of resource: rpf
ID of vrf-name
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
GROUP-MAPPINGS-AUTO-RP - Update
Update operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Create
Create operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Delete
Delete operation of resource: group-mappings-auto-rp
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Retrieve
Retrieve operation of resource: group-mappings-auto-rp
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
BSR-GROUP-MAPPINGS - Update
Update operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Create
Create operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Delete
Delete operation of resource: bsr-group-mappings
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Retrieve
Retrieve operation of resource: bsr-group-mappings
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
REGISTER-STATES - Update
Update operation of resource: register-states
register-statesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Create
Create operation of resource: register-states
register-statesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Delete
Delete operation of resource: register-states
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Retrieve
Retrieve operation of resource: register-states
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTE-INTERFACES - Update
Update operation of resource: route-interfaces
route-interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Create
Create operation of resource: route-interfaces
route-interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Delete
Delete operation of resource: route-interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Retrieve
Retrieve operation of resource: route-interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
BSR-CANDIDATE-RP-CACHE - Update
Update operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Create
Create operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Delete
Delete operation of resource: bsr-candidate-rp-cache
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Retrieve
Retrieve operation of resource: bsr-candidate-rp-cache
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTES - Update
Update operation of resource: routes
routesbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Create
Create operation of resource: routes
routesbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Delete
Delete operation of resource: routes
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Retrieve
Retrieve operation of resource: routes
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}
}
SG-EXPIRY-TIMER - Update
Update operation of resource: sg-expiry-timer
sg-expiry-timerbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Create
Create operation of resource: sg-expiry-timer
sg-expiry-timerbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Delete
Delete operation of resource: sg-expiry-timer
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Retrieve
Retrieve operation of resource: sg-expiry-timer
ID of vrf-name
Successful operation
Internal Error
RPF-VECTOR-ENABLE - Update
Update operation of resource: rpf-vector-enable
rpf-vector-enablebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Create
Create operation of resource: rpf-vector-enable
rpf-vector-enablebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Delete
Delete operation of resource: rpf-vector-enable
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Retrieve
Retrieve operation of resource: rpf-vector-enable
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
SSM - Update
Update operation of resource: ssm
ssmbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Create
Create operation of resource: ssm
ssmbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Delete
Delete operation of resource: ssm
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Retrieve
Retrieve operation of resource: ssm
ID of vrf-name
Successful operation
Internal Error
INJECTS - Update
Update operation of resource: injects
injectsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INJECTS - Create
Create operation of resource: injects
injectsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INJECTS - Delete
Delete operation of resource: injects
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INJECTS - Retrieve
Retrieve operation of resource: injects
ID of vrf-name
Successful operation
Internal Error
INJECT - Update
Update operation of resource: inject
injectbody object
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
INJECT - Create
Create operation of resource: inject
injectbody object
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
INJECT - Delete
Delete operation of resource: inject
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
INJECT - Retrieve
Retrieve operation of resource: inject
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
BIDIR-RP-ADDRESSES - Update
Update operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Create
Create operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Delete
Delete operation of resource: bidir-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Retrieve
Retrieve operation of resource: bidir-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
BIDIR-RP-ADDRESS - Update
Update operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Create
Create operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Delete
Delete operation of resource: bidir-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Retrieve
Retrieve operation of resource: bidir-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
BSR - Update
Update operation of resource: bsr
bsrbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Create
Create operation of resource: bsr
bsrbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Delete
Delete operation of resource: bsr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Retrieve
Retrieve operation of resource: bsr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
CANDIDATE-BSR - Update
Update operation of resource: candidate-bsr
candidate-bsrbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Create
Create operation of resource: candidate-bsr
candidate-bsrbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Delete
Delete operation of resource: candidate-bsr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Retrieve
Retrieve operation of resource: candidate-bsr
ID of vrf-name
Successful operation
Internal Error
CANDIDATE-RPS - Update
Update operation of resource: candidate-rps
candidate-rpsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Create
Create operation of resource: candidate-rps
candidate-rpsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Delete
Delete operation of resource: candidate-rps
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
CANDIDATE-RP - Update
Update operation of resource: candidate-rp
candidate-rpbody object
ID of vrf-name
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Create
Create operation of resource: candidate-rp
candidate-rpbody object
ID of vrf-name
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Delete
Delete operation of resource: candidate-rp
ID of vrf-name
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
ID of vrf-name
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
MOFRR - Update
Update operation of resource: mofrr
mofrrbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MOFRR - Create
Create operation of resource: mofrr
mofrrbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MOFRR - Delete
Delete operation of resource: mofrr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MOFRR - Retrieve
Retrieve operation of resource: mofrr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}
}
CLONE-JOINS - Update
Update operation of resource: clone-joins
clone-joinsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOINS - Create
Create operation of resource: clone-joins
clone-joinsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOINS - Delete
Delete operation of resource: clone-joins
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOINS - Retrieve
Retrieve operation of resource: clone-joins
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
CLONE-JOIN - Update
Update operation of resource: clone-join
clone-joinbody object
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOIN - Create
Create operation of resource: clone-join
clone-joinbody object
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOIN - Delete
Delete operation of resource: clone-join
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOIN - Retrieve
Retrieve operation of resource: clone-join
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
CLONE-SOURCES - Update
Update operation of resource: clone-sources
clone-sourcesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCES - Create
Create operation of resource: clone-sources
clone-sourcesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCES - Delete
Delete operation of resource: clone-sources
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCES - Retrieve
Retrieve operation of resource: clone-sources
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
CLONE-SOURCE - Update
Update operation of resource: clone-source
clone-sourcebody object
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCE - Create
Create operation of resource: clone-source
clone-sourcebody object
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCE - Delete
Delete operation of resource: clone-source
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCE - Retrieve
Retrieve operation of resource: clone-source
ID of vrf-name
ID of source primary backup prefix-length
Successful operation
Internal Error
PATHS - Update
Update operation of resource: paths
pathsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PATHS - Create
Create operation of resource: paths
pathsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PATHS - Delete
Delete operation of resource: paths
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PATHS - Retrieve
Retrieve operation of resource: paths
ID of vrf-name
Successful operation
Internal Error
PATH - Update
Update operation of resource: path
pathbody object
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Create
Create operation of resource: path
pathbody object
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Delete
Delete operation of resource: path
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Retrieve
Retrieve operation of resource: path
ID of vrf-name
ID of source-address prefix-length
Successful operation
Internal Error
ALLOW-RP - Update
Update operation of resource: allow-rp
allow-rpbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Create
Create operation of resource: allow-rp
allow-rpbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Delete
Delete operation of resource: allow-rp
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Retrieve
Retrieve operation of resource: allow-rp
ID of vrf-name
Successful operation
Internal Error
CONVERGENCE - Update
Update operation of resource: convergence
convergencebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Create
Create operation of resource: convergence
convergencebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Delete
Delete operation of resource: convergence
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Retrieve
Retrieve operation of resource: convergence
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
MAXIMUM-ROUTES - Update
Update operation of resource: maximum-routes
maximum-routesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Create
Create operation of resource: maximum-routes
maximum-routesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Delete
Delete operation of resource: maximum-routes
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Retrieve
Retrieve operation of resource: maximum-routes
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ : {Configure Non-stop forwarding (NSF) options "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ : {Configure Non-stop forwarding (NSF) options "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Configure Non-stop forwarding (NSF) options "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
SPARSE-MODE-RP-ADDRESSES - Update
Update operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Create
Create operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Delete
Delete operation of resource: sparse-mode-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Retrieve
Retrieve operation of resource: sparse-mode-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
SPARSE-MODE-RP-ADDRESS - Update
Update operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Create
Create operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Delete
Delete operation of resource: sparse-mode-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Retrieve
Retrieve operation of resource: sparse-mode-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
RPF - Update
Update operation of resource: rpf
rpfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Create
Create operation of resource: rpf
rpfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Delete
Delete operation of resource: rpf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Retrieve
Retrieve operation of resource: rpf
ID of vrf-name
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, : {Maximum for number of group mappings from\nautorp mapping agent "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, : {Override default maximum for number of\nsparse-mode source registers "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, : {Override default maximum for number of routes "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default maximum for number of\nroute-interfaces "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor PIM group mapping ranges from BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : {Override default global maximum and threshold\nfor C-RP set in BSR "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
GROUP-MAPPINGS-AUTO-RP - Update
Update operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Create
Create operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Delete
Delete operation of resource: group-mappings-auto-rp
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Retrieve
Retrieve operation of resource: group-mappings-auto-rp
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
BSR-GROUP-MAPPINGS - Update
Update operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Create
Create operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Delete
Delete operation of resource: bsr-group-mappings
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Retrieve
Retrieve operation of resource: bsr-group-mappings
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
REGISTER-STATES - Update
Update operation of resource: register-states
register-statesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Create
Create operation of resource: register-states
register-statesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Delete
Delete operation of resource: register-states
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Retrieve
Retrieve operation of resource: register-states
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTE-INTERFACES - Update
Update operation of resource: route-interfaces
route-interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Create
Create operation of resource: route-interfaces
route-interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Delete
Delete operation of resource: route-interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Retrieve
Retrieve operation of resource: route-interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
BSR-CANDIDATE-RP-CACHE - Update
Update operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Create
Create operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Delete
Delete operation of resource: bsr-candidate-rp-cache
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Retrieve
Retrieve operation of resource: bsr-candidate-rp-cache
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTES - Update
Update operation of resource: routes
routesbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Create
Create operation of resource: routes
routesbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Delete
Delete operation of resource: routes
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Retrieve
Retrieve operation of resource: routes
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}
}
SG-EXPIRY-TIMER - Update
Update operation of resource: sg-expiry-timer
sg-expiry-timerbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Create
Create operation of resource: sg-expiry-timer
sg-expiry-timerbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Delete
Delete operation of resource: sg-expiry-timer
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Retrieve
Retrieve operation of resource: sg-expiry-timer
ID of vrf-name
Successful operation
Internal Error
RPF-VECTOR-ENABLE - Update
Update operation of resource: rpf-vector-enable
rpf-vector-enablebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Create
Create operation of resource: rpf-vector-enable
rpf-vector-enablebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Delete
Delete operation of resource: rpf-vector-enable
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Retrieve
Retrieve operation of resource: rpf-vector-enable
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
SSM - Update
Update operation of resource: ssm
ssmbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Create
Create operation of resource: ssm
ssmbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Delete
Delete operation of resource: ssm
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Retrieve
Retrieve operation of resource: ssm
ID of vrf-name
Successful operation
Internal Error
BIDIR-RP-ADDRESSES - Update
Update operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Create
Create operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Delete
Delete operation of resource: bidir-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Retrieve
Retrieve operation of resource: bidir-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
BIDIR-RP-ADDRESS - Update
Update operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Create
Create operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of vrf-name
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Delete
Delete operation of resource: bidir-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Retrieve
Retrieve operation of resource: bidir-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
BSR - Update
Update operation of resource: bsr
bsrbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Create
Create operation of resource: bsr
bsrbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Delete
Delete operation of resource: bsr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Retrieve
Retrieve operation of resource: bsr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
CANDIDATE-BSR - Update
Update operation of resource: candidate-bsr
candidate-bsrbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Create
Create operation of resource: candidate-bsr
candidate-bsrbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Delete
Delete operation of resource: candidate-bsr
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Retrieve
Retrieve operation of resource: candidate-bsr
ID of vrf-name
Successful operation
Internal Error
CANDIDATE-RPS - Update
Update operation of resource: candidate-rps
candidate-rpsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Create
Create operation of resource: candidate-rps
candidate-rpsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Delete
Delete operation of resource: candidate-rps
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
CANDIDATE-RP - Update
Update operation of resource: candidate-rp
candidate-rpbody object
ID of vrf-name
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Create
Create operation of resource: candidate-rp
candidate-rpbody object
ID of vrf-name
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Delete
Delete operation of resource: candidate-rp
ID of vrf-name
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
ID of vrf-name
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
ALLOW-RP - Update
Update operation of resource: allow-rp
allow-rpbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Create
Create operation of resource: allow-rp
allow-rpbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Delete
Delete operation of resource: allow-rp
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Retrieve
Retrieve operation of resource: allow-rp
ID of vrf-name
Successful operation
Internal Error
EMBEDDED-RP-ADDRESSES - Update
Update operation of resource: embedded-rp-addresses
embedded-rp-addressesbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESSES - Create
Create operation of resource: embedded-rp-addresses
embedded-rp-addressesbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESSES - Delete
Delete operation of resource: embedded-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESSES - Retrieve
Retrieve operation of resource: embedded-rp-addresses
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"rp-address": "string", RP address of the Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
EMBEDDED-RP-ADDRESS - Update
Update operation of resource: embedded-rp-address
embedded-rp-addressbody object
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESS - Create
Create operation of resource: embedded-rp-address
embedded-rp-addressbody object
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESS - Delete
Delete operation of resource: embedded-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESS - Retrieve
Retrieve operation of resource: embedded-rp-address
ID of vrf-name
ID of rp-address
Successful operation
Internal Error
CONVERGENCE - Update
Update operation of resource: convergence
convergencebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Create
Create operation of resource: convergence
convergencebody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Delete
Delete operation of resource: convergence
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Retrieve
Retrieve operation of resource: convergence
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
MAXIMUM-ROUTES - Update
Update operation of resource: maximum-routes
maximum-routesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Create
Create operation of resource: maximum-routes
maximum-routesbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Delete
Delete operation of resource: maximum-routes
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Retrieve
Retrieve operation of resource: maximum-routes
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
DEFAULT-CONTEXT - Update
Update operation of resource: default-context
default-contextbody object
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Create
Create operation of resource: default-context
default-contextbody object
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Delete
Delete operation of resource: default-context
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Hash Mask Length for this candidate BSR
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Hash Mask Length for this candidate BSR
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Request Content-Types: application/json
Request Example
{ "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Request Content-Types: application/json
Request Example
{ "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
},
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages
"neighbor-filter": "string", Access-list of neighbors to be filtered {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"embedded-rp-disable": "null", Set Embedded RP processing support
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured {
"neighbor-filter": "string", Access-list of neighbors to be filtered
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, {
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { : {Configure RPF-redirect bundle for interface.\nApplicable for IPv4 only "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
MAXIMUM-ROUTES - Update
Update operation of resource: maximum-routes
maximum-routesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Create
Create operation of resource: maximum-routes
maximum-routesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Delete
Delete operation of resource: maximum-routes
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Retrieve
Retrieve operation of resource: maximum-routes
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
SPARSE-MODE-RP-ADDRESSES - Update
Update operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Create
Create operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Delete
Delete operation of resource: sparse-mode-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Retrieve
Retrieve operation of resource: sparse-mode-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
SPARSE-MODE-RP-ADDRESS - Update
Update operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Create
Create operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Delete
Delete operation of resource: sparse-mode-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Retrieve
Retrieve operation of resource: sparse-mode-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
RPF - Update
Update operation of resource: rpf
rpfbody object
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Create
Create operation of resource: rpf
rpfbody object
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Delete
Delete operation of resource: rpf
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Retrieve
Retrieve operation of resource: rpf
Successful operation
Internal Error
SG-EXPIRY-TIMER - Update
Update operation of resource: sg-expiry-timer
sg-expiry-timerbody object
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Create
Create operation of resource: sg-expiry-timer
sg-expiry-timerbody object
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Delete
Delete operation of resource: sg-expiry-timer
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Retrieve
Retrieve operation of resource: sg-expiry-timer
Successful operation
Internal Error
RPF-VECTOR-ENABLE - Update
Update operation of resource: rpf-vector-enable
rpf-vector-enablebody object
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Create
Create operation of resource: rpf-vector-enable
rpf-vector-enablebody object
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Delete
Delete operation of resource: rpf-vector-enable
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Retrieve
Retrieve operation of resource: rpf-vector-enable
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
NSF - Update
Update operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Create
Create operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Delete
Delete operation of resource: nsf
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Retrieve
Retrieve operation of resource: nsf
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
BSR-GLOBAL-GROUP-MAPPINGS - Update
Update operation of resource: bsr-global-group-mappings
bsr-global-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-GROUP-MAPPINGS - Create
Create operation of resource: bsr-global-group-mappings
bsr-global-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-GROUP-MAPPINGS - Delete
Delete operation of resource: bsr-global-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-GROUP-MAPPINGS - Retrieve
Retrieve operation of resource: bsr-global-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
}
}
GLOBAL-ROUTES - Update
Update operation of resource: global-routes
global-routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTES - Create
Create operation of resource: global-routes
global-routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTES - Delete
Delete operation of resource: global-routes
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTES - Retrieve
Retrieve operation of resource: global-routes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}
}
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Update
Update operation of resource: global-group-mappings-auto-rp
global-group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Create
Create operation of resource: global-group-mappings-auto-rp
global-group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Delete
Delete operation of resource: global-group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Retrieve
Retrieve operation of resource: global-group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}
}
BSR-GLOBAL-CANDIDATE-RP-CACHE - Update
Update operation of resource: bsr-global-candidate-rp-cache
bsr-global-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-CANDIDATE-RP-CACHE - Create
Create operation of resource: bsr-global-candidate-rp-cache
bsr-global-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-CANDIDATE-RP-CACHE - Delete
Delete operation of resource: bsr-global-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-CANDIDATE-RP-CACHE - Retrieve
Retrieve operation of resource: bsr-global-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
GLOBAL-REGISTER-STATES - Update
Update operation of resource: global-register-states
global-register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-REGISTER-STATES - Create
Create operation of resource: global-register-states
global-register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-REGISTER-STATES - Delete
Delete operation of resource: global-register-states
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-REGISTER-STATES - Retrieve
Retrieve operation of resource: global-register-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
GLOBAL-ROUTE-INTERFACES - Update
Update operation of resource: global-route-interfaces
global-route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTE-INTERFACES - Create
Create operation of resource: global-route-interfaces
global-route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTE-INTERFACES - Delete
Delete operation of resource: global-route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTE-INTERFACES - Retrieve
Retrieve operation of resource: global-route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
GROUP-MAPPINGS-AUTO-RP - Update
Update operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Create
Create operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Delete
Delete operation of resource: group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Retrieve
Retrieve operation of resource: group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
BSR-GROUP-MAPPINGS - Update
Update operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Create
Create operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Delete
Delete operation of resource: bsr-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Retrieve
Retrieve operation of resource: bsr-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
REGISTER-STATES - Update
Update operation of resource: register-states
register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Create
Create operation of resource: register-states
register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Delete
Delete operation of resource: register-states
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Retrieve
Retrieve operation of resource: register-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTE-INTERFACES - Update
Update operation of resource: route-interfaces
route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Create
Create operation of resource: route-interfaces
route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Delete
Delete operation of resource: route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Retrieve
Retrieve operation of resource: route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
BSR-CANDIDATE-RP-CACHE - Update
Update operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Create
Create operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Delete
Delete operation of resource: bsr-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Retrieve
Retrieve operation of resource: bsr-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTES - Update
Update operation of resource: routes
routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Create
Create operation of resource: routes
routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Delete
Delete operation of resource: routes
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Retrieve
Retrieve operation of resource: routes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}
}
SSM - Update
Update operation of resource: ssm
ssmbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Create
Create operation of resource: ssm
ssmbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Delete
Delete operation of resource: ssm
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Retrieve
Retrieve operation of resource: ssm
Successful operation
Internal Error
BIDIR-RP-ADDRESSES - Update
Update operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Create
Create operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Delete
Delete operation of resource: bidir-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Retrieve
Retrieve operation of resource: bidir-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
BIDIR-RP-ADDRESS - Update
Update operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Create
Create operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Delete
Delete operation of resource: bidir-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Retrieve
Retrieve operation of resource: bidir-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
BSR - Update
Update operation of resource: bsr
bsrbody object
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Create
Create operation of resource: bsr
bsrbody object
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Delete
Delete operation of resource: bsr
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Retrieve
Retrieve operation of resource: bsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
CANDIDATE-BSR - Update
Update operation of resource: candidate-bsr
candidate-bsrbody object
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Create
Create operation of resource: candidate-bsr
candidate-bsrbody object
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Delete
Delete operation of resource: candidate-bsr
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Retrieve
Retrieve operation of resource: candidate-bsr
Successful operation
Internal Error
CANDIDATE-RPS - Update
Update operation of resource: candidate-rps
candidate-rpsbody object
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Create
Create operation of resource: candidate-rps
candidate-rpsbody object
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Delete
Delete operation of resource: candidate-rps
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
CANDIDATE-RP - Update
Update operation of resource: candidate-rp
candidate-rpbody object
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Create
Create operation of resource: candidate-rp
candidate-rpbody object
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Delete
Delete operation of resource: candidate-rp
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
ALLOW-RP - Update
Update operation of resource: allow-rp
allow-rpbody object
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Create
Create operation of resource: allow-rp
allow-rpbody object
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Delete
Delete operation of resource: allow-rp
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Retrieve
Retrieve operation of resource: allow-rp
Successful operation
Internal Error
EMBEDDED-RP-ADDRESSES - Update
Update operation of resource: embedded-rp-addresses
embedded-rp-addressesbody object
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESSES - Create
Create operation of resource: embedded-rp-addresses
embedded-rp-addressesbody object
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESSES - Delete
Delete operation of resource: embedded-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESSES - Retrieve
Retrieve operation of resource: embedded-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"rp-address": "string", RP address of the Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
EMBEDDED-RP-ADDRESS - Update
Update operation of resource: embedded-rp-address
embedded-rp-addressbody object
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESS - Create
Create operation of resource: embedded-rp-address
embedded-rp-addressbody object
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESS - Delete
Delete operation of resource: embedded-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
EMBEDDED-RP-ADDRESS - Retrieve
Retrieve operation of resource: embedded-rp-address
ID of rp-address
Successful operation
Internal Error
CONVERGENCE - Update
Update operation of resource: convergence
convergencebody object
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Create
Create operation of resource: convergence
convergencebody object
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Delete
Delete operation of resource: convergence
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Retrieve
Retrieve operation of resource: convergence
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", Enable Multicast Only FRR
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", Enable Multicast Only FRR
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", Enable Multicast Only FRR
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Mask length
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", Enable Multicast Only FRR
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", Enable Multicast Only FRR
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", Enable Multicast Only FRR
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Mask length
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access list of groups that should map to a\ngiven RP
"announce-period": "string", Time between discovery messages
"interface-name": "string" The name of interface
}
]
}, "lifetime": "integer" Override default maximum lifetime for PIM NSF\nmode
range: "10..600"
units: "second"
}, {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
}, {
"rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
],
"ssm-allow-override": "null", Allow SSM ranges to be overridden by more\nspecific ranges "route-policy": "string" Route policy to select RPF topology
},
"multipath": "string", Enable equal-cost multipath routing
"register-source": "string", Source address to use for register messages
"neighbor-check-on-receive": "null", Enable PIM neighbor checking when receiving PIM\nmessages {
"rpf-proxy-address": "string", RPF Proxy Address
"prefix-length": "string", Mask length
"source-address": "string" Source Address
}
]
},
"neighbor-filter": "string", Access-list of neighbors to be filtered { {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
], "interface-name": "string", The name of interface
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}, "interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
},
"old-register-checksum": "null", Generate registers compatible with older IOS\nversions "enable": "null", Enable Multicast Only FRR
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}, "rp-list-name": "string", Access-list specifiying applicable RPs
"group-list-name": "string" Access-list specifiying applicable groups
},
"auto-rp-disable": "null", Disable Rendezvous Point discovery through the\nAutoRP protocol
"neighbor-check-on-send": "null", Enable PIM neighbor checking when sending\njoin-prunes "route-policy": "string" Route policy to select RPF topology
},
"log-neighbor-changes": "null", PIM neighbor state change logging is turned on\nif configured { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", Enable Multicast Only FRR
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Configure PIM State Limits
range: "1..1100000"
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}, "enable": "boolean", Enable Multicast Only FRR
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Advertisement interval
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}, "priority": "string", Priority of the CRP
"prefix-length": "string", Mask length
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}, "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}, "range": "string", Access list of groups enabled with SSM
"disable": "boolean" TRUE if SSM is disabled on this router
},
"rp-static-deny": "string", Configure static RP deny range
"spt-threshold-infinity": "string", Configure threshold of infinity for switching to\nSPT on last-hop "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}, {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
},
"accept-register": "string", Access-list which specifies unauthorized sources
"suppress-data-registers": "null", Suppress data registers after initial state\nsetup "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
},
"suppress-rpf-prunes": "null" Suppress prunes triggered as a result of RPF\nchanges
}
}
RPF-REDIRECT - Update
Update operation of resource: rpf-redirect
rpf-redirectbody object
Successful operation
Internal Error
Response Content-Types: application/json
RPF-REDIRECT - Create
Create operation of resource: rpf-redirect
rpf-redirectbody object
Successful operation
Internal Error
Response Content-Types: application/json
RPF-REDIRECT - Delete
Delete operation of resource: rpf-redirect
Successful operation
Internal Error
Response Content-Types: application/json
RPF-REDIRECT - Retrieve
Retrieve operation of resource: rpf-redirect
Successful operation
Internal Error
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
},
"enable": "null", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"interface-name": "string", The name of interface "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}, "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
},
"neighbor-filter": "string", Access-list of neighbors to be filtered
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"interface-enable": "boolean", Enable PIM processing on the interface
"dr-priority": "integer", Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"bsr-border": "boolean" BSR Border configuration for Interface
}
]
}
REDIRECT-BUNDLE - Update
Update operation of resource: redirect-bundle
redirect-bundlebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REDIRECT-BUNDLE - Create
Create operation of resource: redirect-bundle
redirect-bundlebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REDIRECT-BUNDLE - Delete
Delete operation of resource: redirect-bundle
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
REDIRECT-BUNDLE - Retrieve
Retrieve operation of resource: redirect-bundle
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "interface-bandwidth": "integer", Interface bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"threshold-bandwidth": "integer", Threshold bandwidth in Kbps
range: "0..100000000"
units: "kbit/s"
"bundle-name": "string" Bundle name
}
}
MAXIMUM-ROUTES - Update
Update operation of resource: maximum-routes
maximum-routesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Create
Create operation of resource: maximum-routes
maximum-routesbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Delete
Delete operation of resource: maximum-routes
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM-ROUTES - Retrieve
Retrieve operation of resource: maximum-routes
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum": "integer", Maximum number of routes for this interface
range: "1..1100000"
"access-list-name": "string" Access-list to account for
}
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "boolean", TRUE to enable BFD. FALSE to disable and to\nprevent inheritance from a parent
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby PIM
range: "2..50"
"interval": "integer" Hello interval for BFD sessions created by PIM
range: "30..600"
units: "second"
default: "60"
}
}
AUTO-RP-CANDIDATE-RPS - Update
Update operation of resource: auto-rp-candidate-rps
auto-rp-candidate-rpsbody object
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP
"announce-period": "string", Time between announcements
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-CANDIDATE-RPS - Create
Create operation of resource: auto-rp-candidate-rps
auto-rp-candidate-rpsbody object
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP
"announce-period": "string", Time between announcements
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-CANDIDATE-RPS - Delete
Delete operation of resource: auto-rp-candidate-rps
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-CANDIDATE-RPS - Retrieve
Retrieve operation of resource: auto-rp-candidate-rps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP
"announce-period": "string", Time between announcements
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced
}
]
}
}
AUTO-RP-CANDIDATE-RP - Update
Update operation of resource: auto-rp-candidate-rp
auto-rp-candidate-rpbody object
ID of interface-name protocol-mode
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP
"announce-period": "string", Time between announcements
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-CANDIDATE-RP - Create
Create operation of resource: auto-rp-candidate-rp
auto-rp-candidate-rpbody object
ID of interface-name protocol-mode
Request Content-Types: application/json
Request Example
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP
"announce-period": "string", Time between announcements
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-CANDIDATE-RP - Delete
Delete operation of resource: auto-rp-candidate-rp
ID of interface-name protocol-mode
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-CANDIDATE-RP - Retrieve
Retrieve operation of resource: auto-rp-candidate-rp
ID of interface-name protocol-mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"protocol-mode": "string", Protocol Mode
"ttl": "string", TTL in Hops
"access-list-name": "string", Access-list specifying the group range for\nthe Candidate-RP
"announce-period": "string", Time between announcements
"interface-name": "string" Interface from which Candidate-RP packets\nwill be sourced
}
]
}
AUTO-RP-MAPPING-AGENT - Update
Update operation of resource: auto-rp-mapping-agent
auto-rp-mapping-agentbody object
Request Content-Types: application/json
Request Example
{ "interface-name": "string", Interface from which mapping packets will be\nsourced
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-MAPPING-AGENT - Create
Create operation of resource: auto-rp-mapping-agent
auto-rp-mapping-agentbody object
Request Content-Types: application/json
Request Example
{ "interface-name": "string", Interface from which mapping packets will be\nsourced
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-MAPPING-AGENT - Delete
Delete operation of resource: auto-rp-mapping-agent
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-RP-MAPPING-AGENT - Retrieve
Retrieve operation of resource: auto-rp-mapping-agent
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "interface-name": "string", Interface from which mapping packets will be\nsourced
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}, "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}
}
PARAMETERS - Update
Update operation of resource: parameters
parametersbody object
Request Content-Types: application/json
Request Example
{ "interface-name": "string", Interface from which mapping packets will be\nsourced
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PARAMETERS - Create
Create operation of resource: parameters
parametersbody object
Request Content-Types: application/json
Request Example
{ "interface-name": "string", Interface from which mapping packets will be\nsourced
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PARAMETERS - Delete
Delete operation of resource: parameters
Successful operation
Internal Error
Response Content-Types: application/json
PARAMETERS - Retrieve
Retrieve operation of resource: parameters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "interface-name": "string", Interface from which mapping packets will be\nsourced
"announce-period": "string", Time between discovery messages
"ttl": "string" TTL in Hops
}
}
CACHE-LIMIT - Update
Update operation of resource: cache-limit
cache-limitbody object
Request Content-Types: application/json
Request Example
{ "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CACHE-LIMIT - Create
Create operation of resource: cache-limit
cache-limitbody object
Request Content-Types: application/json
Request Example
{ "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CACHE-LIMIT - Delete
Delete operation of resource: cache-limit
Successful operation
Internal Error
Response Content-Types: application/json
CACHE-LIMIT - Retrieve
Retrieve operation of resource: cache-limit
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-cache-entry": "integer", Maximum number of mapping cache entries
range: "1..1000"
"threshold-cache-entry": "integer" Warning threshold number of cache entries
range: "1..1000"
default: "450"
}
}
SPARSE-MODE-RP-ADDRESSES - Update
Update operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Create
Create operation of resource: sparse-mode-rp-addresses
sparse-mode-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Delete
Delete operation of resource: sparse-mode-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESSES - Retrieve
Retrieve operation of resource: sparse-mode-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
SPARSE-MODE-RP-ADDRESS - Update
Update operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Create
Create operation of resource: sparse-mode-rp-address
sparse-mode-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Delete
Delete operation of resource: sparse-mode-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
SPARSE-MODE-RP-ADDRESS - Retrieve
Retrieve operation of resource: sparse-mode-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
INHERITABLE-DEFAULTS - Update
Update operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Create
Create operation of resource: inheritable-defaults
inheritable-defaultsbody object
Request Content-Types: application/json
Request Example
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Delete
Delete operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
INHERITABLE-DEFAULTS - Retrieve
Retrieve operation of resource: inheritable-defaults
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "jp-interval": "integer", Join-Prune interval in seconds
range: "10..600"
units: "second"
"hello-interval": "integer", Hello interval in seconds
range: "1..3600"
units: "second"
"convergence-timeout": "integer", Convergency timeout in seconds
range: "1800..2400"
units: "second"
"join-prune-mtu": "integer", Join-Prune MTU in Bytes
range: "576..65535"
units: "byte"
"override-interval": "integer", Override interval in milliseconds
range: "400..65535"
units: "millisecond"
"propagation-delay": "integer", Propagation delay in milli seconds
range: "100..32767"
units: "millisecond"
"dr-priority": "integer" Hello DR priority, preference given to larger\nvalue
range: "0..4294967295"
}
}
RPF - Update
Update operation of resource: rpf
rpfbody object
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Create
Create operation of resource: rpf
rpfbody object
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Delete
Delete operation of resource: rpf
Successful operation
Internal Error
Response Content-Types: application/json
RPF - Retrieve
Retrieve operation of resource: rpf
Successful operation
Internal Error
SG-EXPIRY-TIMER - Update
Update operation of resource: sg-expiry-timer
sg-expiry-timerbody object
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Create
Create operation of resource: sg-expiry-timer
sg-expiry-timerbody object
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Delete
Delete operation of resource: sg-expiry-timer
Successful operation
Internal Error
Response Content-Types: application/json
SG-EXPIRY-TIMER - Retrieve
Retrieve operation of resource: sg-expiry-timer
Successful operation
Internal Error
RPF-VECTOR-ENABLE - Update
Update operation of resource: rpf-vector-enable
rpf-vector-enablebody object
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Create
Create operation of resource: rpf-vector-enable
rpf-vector-enablebody object
Request Content-Types: application/json
Request Example
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Delete
Delete operation of resource: rpf-vector-enable
Successful operation
Internal Error
Response Content-Types: application/json
RPF-VECTOR-ENABLE - Retrieve
Retrieve operation of resource: rpf-vector-enable
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", RPF Vector is turned on if configured
"disable-ibgp": "null", Disable RPF Vector origination over iBGP\nsessions
"allow-ebgp": "null" Allow RPF Vector origination over eBGP sessions
}
}
NSF - Update
Update operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Create
Create operation of resource: nsf
nsfbody object
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Delete
Delete operation of resource: nsf
Successful operation
Internal Error
Response Content-Types: application/json
NSF - Retrieve
Retrieve operation of resource: nsf
Successful operation
Internal Error
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
Request Content-Types: application/json
Request Example
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "global-low-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}, "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
},
"global-high-priority-packet-queue": "integer", Maximum packet queue size in bytes
range: "0..2147483648"
units: "byte" "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}, "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}, "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
}
BSR-GLOBAL-GROUP-MAPPINGS - Update
Update operation of resource: bsr-global-group-mappings
bsr-global-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-GROUP-MAPPINGS - Create
Create operation of resource: bsr-global-group-mappings
bsr-global-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-GROUP-MAPPINGS - Delete
Delete operation of resource: bsr-global-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-GROUP-MAPPINGS - Retrieve
Retrieve operation of resource: bsr-global-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : { "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-group-mappings": "integer" Global Maximum number of PIM group mapping\nranges from BSR
range: "1..10000"
}
}
GLOBAL-ROUTES - Update
Update operation of resource: global-routes
global-routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTES - Create
Create operation of resource: global-routes
global-routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTES - Delete
Delete operation of resource: global-routes
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTES - Retrieve
Retrieve operation of resource: global-routes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}
}
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Update
Update operation of resource: global-group-mappings-auto-rp
global-group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Create
Create operation of resource: global-group-mappings-auto-rp
global-group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Delete
Delete operation of resource: global-group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-GROUP-MAPPINGS-AUTO-RP - Retrieve
Retrieve operation of resource: global-group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-global-group-ranges-auto-rp": "integer", Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
"maximum-global-group-ranges-auto-rp": "integer" Maximum number of PIM group mappings from\nautorp
range: "1..10000"
}
}
BSR-GLOBAL-CANDIDATE-RP-CACHE - Update
Update operation of resource: bsr-global-candidate-rp-cache
bsr-global-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-CANDIDATE-RP-CACHE - Create
Create operation of resource: bsr-global-candidate-rp-cache
bsr-global-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-CANDIDATE-RP-CACHE - Delete
Delete operation of resource: bsr-global-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GLOBAL-CANDIDATE-RP-CACHE - Retrieve
Retrieve operation of resource: bsr-global-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-global-candidate-rp-cache": "integer" Global Maximum number of PIM C-RP Sets from\nBSR
range: "1..10000"
}
}
GLOBAL-REGISTER-STATES - Update
Update operation of resource: global-register-states
global-register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-REGISTER-STATES - Create
Create operation of resource: global-register-states
global-register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-REGISTER-STATES - Delete
Delete operation of resource: global-register-states
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-REGISTER-STATES - Retrieve
Retrieve operation of resource: global-register-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
GLOBAL-ROUTE-INTERFACES - Update
Update operation of resource: global-route-interfaces
global-route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTE-INTERFACES - Create
Create operation of resource: global-route-interfaces
global-route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTE-INTERFACES - Delete
Delete operation of resource: global-route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-ROUTE-INTERFACES - Retrieve
Retrieve operation of resource: global-route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
GROUP-MAPPINGS-AUTO-RP - Update
Update operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Create
Create operation of resource: group-mappings-auto-rp
group-mappings-auto-rpbody object
Request Content-Types: application/json
Request Example
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Delete
Delete operation of resource: group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-MAPPINGS-AUTO-RP - Retrieve
Retrieve operation of resource: group-mappings-auto-rp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-group-ranges-auto-rp": "integer", Maximum number of PIM group mappings from\nautorp
range: "1..10000"
"threshold-group-ranges-auto-rp": "integer" Warning threshold number of PIM group mappings\nfrom autorp
range: "1..10000"
default: "450"
}
}
BSR-GROUP-MAPPINGS - Update
Update operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Create
Create operation of resource: bsr-group-mappings
bsr-group-mappingsbody object
Request Content-Types: application/json
Request Example
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Delete
Delete operation of resource: bsr-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
BSR-GROUP-MAPPINGS - Retrieve
Retrieve operation of resource: bsr-group-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"bsr-maximum-group-ranges": "integer" Maximum number of PIM group mappings from BSR
range: "1..10000"
}
}
REGISTER-STATES - Update
Update operation of resource: register-states
register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Create
Create operation of resource: register-states
register-statesbody object
Request Content-Types: application/json
Request Example
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Delete
Delete operation of resource: register-states
Successful operation
Internal Error
Response Content-Types: application/json
REGISTER-STATES - Retrieve
Retrieve operation of resource: register-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-register-states": "integer", Maximum number of PIM Sparse-Mode register\nstates
range: "0..75000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTE-INTERFACES - Update
Update operation of resource: route-interfaces
route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Create
Create operation of resource: route-interfaces
route-interfacesbody object
Request Content-Types: application/json
Request Example
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Delete
Delete operation of resource: route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
ROUTE-INTERFACES - Retrieve
Retrieve operation of resource: route-interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-route-interfaces": "integer", Maximum number of PIM route-interfaces
range: "1..1100000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
BSR-CANDIDATE-RP-CACHE - Update
Update operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Create
Create operation of resource: bsr-candidate-rp-cache
bsr-candidate-rp-cachebody object
Request Content-Types: application/json
Request Example
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Delete
Delete operation of resource: bsr-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
BSR-CANDIDATE-RP-CACHE - Retrieve
Retrieve operation of resource: bsr-candidate-rp-cache
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "bsr-maximum-candidate-rp-cache": "integer", Maximum number of BSR C-RP cache setting
range: "1..10000"
"warning-threshold": "integer" Set threshold to print warning
range: "1..200000"
default: "500"
}
}
ROUTES - Update
Update operation of resource: routes
routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Create
Create operation of resource: routes
routesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Delete
Delete operation of resource: routes
Successful operation
Internal Error
Response Content-Types: application/json
ROUTES - Retrieve
Retrieve operation of resource: routes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "warning-threshold": "integer", Set threshold to print warning
range: "1..200000"
default: "500"
"maximum-routes": "integer" Maximum number of PIM routes
range: "1..200000"
}
}
SSM - Update
Update operation of resource: ssm
ssmbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Create
Create operation of resource: ssm
ssmbody object
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Delete
Delete operation of resource: ssm
Successful operation
Internal Error
Response Content-Types: application/json
SSM - Retrieve
Retrieve operation of resource: ssm
Successful operation
Internal Error
INJECTS - Update
Update operation of resource: injects
injectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
INJECTS - Create
Create operation of resource: injects
injectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
INJECTS - Delete
Delete operation of resource: injects
Successful operation
Internal Error
Response Content-Types: application/json
INJECTS - Retrieve
Retrieve operation of resource: injects
Successful operation
Internal Error
INJECT - Update
Update operation of resource: inject
injectbody object
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
INJECT - Create
Create operation of resource: inject
injectbody object
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
INJECT - Delete
Delete operation of resource: inject
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
INJECT - Retrieve
Retrieve operation of resource: inject
ID of source-address prefix-length
Successful operation
Internal Error
BIDIR-RP-ADDRESSES - Update
Update operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Create
Create operation of resource: bidir-rp-addresses
bidir-rp-addressesbody object
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Delete
Delete operation of resource: bidir-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESSES - Retrieve
Retrieve operation of resource: bidir-rp-addresses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
}
BIDIR-RP-ADDRESS - Update
Update operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Create
Create operation of resource: bidir-rp-address
bidir-rp-addressbody object
ID of rp-address
Request Content-Types: application/json
Request Example
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Delete
Delete operation of resource: bidir-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
BIDIR-RP-ADDRESS - Retrieve
Retrieve operation of resource: bidir-rp-address
ID of rp-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"auto-rp-override": "boolean", TRUE Indicates if static RP config overrides\nAutoRP and BSR
"rp-address": "string", RP address of Rendezvous Point
"access-list-name": "string" Access list of groups that should map to a\ngiven RP
}
]
}
BSR - Update
Update operation of resource: bsr
bsrbody object
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Create
Create operation of resource: bsr
bsrbody object
Request Content-Types: application/json
Request Example
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Delete
Delete operation of resource: bsr
Successful operation
Internal Error
Response Content-Types: application/json
BSR - Retrieve
Retrieve operation of resource: bsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priority": "string", Priority of the CRP
"prefix-length": "string", Hash Mask Length for this candidate BSR
"address": "string" Address of Candidate-RP
}, {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
}
CANDIDATE-BSR - Update
Update operation of resource: candidate-bsr
candidate-bsrbody object
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Create
Create operation of resource: candidate-bsr
candidate-bsrbody object
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Delete
Delete operation of resource: candidate-bsr
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-BSR - Retrieve
Retrieve operation of resource: candidate-bsr
Successful operation
Internal Error
CANDIDATE-RPS - Update
Update operation of resource: candidate-rps
candidate-rpsbody object
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Create
Create operation of resource: candidate-rps
candidate-rpsbody object
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Delete
Delete operation of resource: candidate-rps
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RPS - Retrieve
Retrieve operation of resource: candidate-rps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
}
CANDIDATE-RP - Update
Update operation of resource: candidate-rp
candidate-rpbody object
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Create
Create operation of resource: candidate-rp
candidate-rpbody object
ID of address mode
Request Content-Types: application/json
Request Example
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Delete
Delete operation of resource: candidate-rp
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-RP - Retrieve
Retrieve operation of resource: candidate-rp
ID of address mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"group-list": "string", Access-list specifying the group range for the\nCandidate-RP
"priority": "string", Priority of the CRP
"interval": "integer", Advertisement interval
range: "30..600"
units: "second"
default: "60"
"mode": "string", SM or Bidir
"address": "string" Address of Candidate-RP
}
]
}
MOFRR - Update
Update operation of resource: mofrr
mofrrbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MOFRR - Create
Create operation of resource: mofrr
mofrrbody object
Request Content-Types: application/json
Request Example
{ "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MOFRR - Delete
Delete operation of resource: mofrr
Successful operation
Internal Error
Response Content-Types: application/json
MOFRR - Retrieve
Retrieve operation of resource: mofrr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": "null", Enable Multicast Only FRR
"flow": "string", Access-list specifying SG that should do FLOW\nMOFRR
"non-revertive": "null", Non-revertive Multicast Only Fast Re-Route {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}, {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
},
"rib": "string" Access-list specifying SG that should do RIB\nMOFRR
}
}
CLONE-JOINS - Update
Update operation of resource: clone-joins
clone-joinsbody object
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOINS - Create
Create operation of resource: clone-joins
clone-joinsbody object
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOINS - Delete
Delete operation of resource: clone-joins
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOINS - Retrieve
Retrieve operation of resource: clone-joins
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
CLONE-JOIN - Update
Update operation of resource: clone-join
clone-joinbody object
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOIN - Create
Create operation of resource: clone-join
clone-joinbody object
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOIN - Delete
Delete operation of resource: clone-join
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-JOIN - Retrieve
Retrieve operation of resource: clone-join
ID of source primary backup prefix-length
Successful operation
Internal Error
CLONE-SOURCES - Update
Update operation of resource: clone-sources
clone-sourcesbody object
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCES - Create
Create operation of resource: clone-sources
clone-sourcesbody object
Request Content-Types: application/json
Request Example
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCES - Delete
Delete operation of resource: clone-sources
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCES - Retrieve
Retrieve operation of resource: clone-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"source": "string", Original source address (S)
"prefix-length": "string", Mask length
"backup": "string", Backup cloned address (S2)
"primary": "string" Primary cloned address (S1)
}
]
}
}
CLONE-SOURCE - Update
Update operation of resource: clone-source
clone-sourcebody object
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCE - Create
Create operation of resource: clone-source
clone-sourcebody object
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCE - Delete
Delete operation of resource: clone-source
ID of source primary backup prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
CLONE-SOURCE - Retrieve
Retrieve operation of resource: clone-source
ID of source primary backup prefix-length
Successful operation
Internal Error
PATHS - Update
Update operation of resource: paths
pathsbody object
Successful operation
Internal Error
Response Content-Types: application/json
PATHS - Create
Create operation of resource: paths
pathsbody object
Successful operation
Internal Error
Response Content-Types: application/json
PATHS - Delete
Delete operation of resource: paths
Successful operation
Internal Error
Response Content-Types: application/json
PATHS - Retrieve
Retrieve operation of resource: paths
Successful operation
Internal Error
PATH - Update
Update operation of resource: path
pathbody object
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Create
Create operation of resource: path
pathbody object
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Delete
Delete operation of resource: path
ID of source-address prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Retrieve
Retrieve operation of resource: path
ID of source-address prefix-length
Successful operation
Internal Error
ALLOW-RP - Update
Update operation of resource: allow-rp
allow-rpbody object
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Create
Create operation of resource: allow-rp
allow-rpbody object
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Delete
Delete operation of resource: allow-rp
Successful operation
Internal Error
Response Content-Types: application/json
ALLOW-RP - Retrieve
Retrieve operation of resource: allow-rp
Successful operation
Internal Error
CONVERGENCE - Update
Update operation of resource: convergence
convergencebody object
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Create
Create operation of resource: convergence
convergencebody object
Request Content-Types: application/json
Request Example
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Delete
Delete operation of resource: convergence
Successful operation
Internal Error
Response Content-Types: application/json
CONVERGENCE - Retrieve
Retrieve operation of resource: convergence
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "rpf-conflict-join-delay": "integer", Dampen first join if RPF path is through one of\nthe downstream neighbor
range: "0..15"
units: "second"
"link-down-prune-delay": "integer" Delay prunes if route join state transitions to\nnot-joined on link down
range: "0..60"
units: "second"
}
}